Skip to content

Conversation

@henrymercer
Copy link
Contributor

Abridge release notes so they display better on the releases page and in Dependabot version updates.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Affects the release process only.

How did/will you validate this change?

Tested locally.

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

Check the release notes during the next bundle and Action release.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

Copilot AI review requested due to automatic review settings January 19, 2026 17:56
@henrymercer henrymercer requested a review from a team as a code owner January 19, 2026 17:56
@github-actions github-actions bot added the size/XS Should be very easy to review label Jan 19, 2026
@github-actions github-actions bot added size/S Should be easy to review and removed size/XS Should be very easy to review labels Jan 19, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request abridges the release notes to improve their display on the releases page and in Dependabot version updates. The changes remove redundant information and add helpful links to bundle releases.

Changes:

  • Modified prepare_changelog.py to exclude version headings and footer text from extracted changelog snippets, as these are redundant when creating GitHub releases
  • Updated bundle_changelog.py to include a link to the corresponding bundle release in changelog notes
  • Added shebangs to both Python scripts for direct executability

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
.github/workflows/script/prepare_changelog.py Simplified changelog extraction logic to exclude version headings and footer text, making release notes more concise
.github/workflows/script/bundle_changelog.py Added bundle release URL linking to provide users with direct access to CLI and language pack changes

esbena
esbena previously approved these changes Jan 20, 2026
Copy link
Contributor

@esbena esbena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds reasonable. For completeness, could you paste your local example? I don't think you need to loop Product in.

mbg
mbg previously approved these changes Jan 20, 2026
Copy link
Member

@mbg mbg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor comment, otherwise ok.

@henrymercer henrymercer dismissed stale reviews from mbg and esbena via ec4eda1 January 20, 2026 14:00
@henrymercer henrymercer requested a review from mbg January 20, 2026 14:00
@henrymercer
Copy link
Contributor Author

Example bundle release note:

  • Update default CodeQL bundle version to 2.23.9. #3393

Example Action release note (the same):

  • Update default CodeQL bundle version to 2.23.9. #3393

@henrymercer henrymercer enabled auto-merge January 20, 2026 14:06
@henrymercer henrymercer merged commit 32d41f3 into main Jan 20, 2026
241 checks passed
@henrymercer henrymercer deleted the henrymercer/abridge-release-notes branch January 20, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants